home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Meeting Pearls 4
/
Meeting Pearls Vol. IV (1996)(GTI - Schatztruhe)[!].iso
/
Pearls
/
libs
/
bgui
/
Docs
/
filereqclass.doc
< prev
next >
Wrap
Text File
|
1995-04-23
|
3KB
|
106 lines
File: filereqclass.doc
Description: Filereqclass documentation.
Copyright: (C) Copyright 1994-1995 Jaba Development.
(C) Copyright 1994-1995 Jan van den Baard.
All Rights Reserved.
------------------------------------------------------------------------------
TABLE OF CONTENTS
filereqclass/--background--
filereqclass/Methods
filereqclass/Attributes
filereqclass/--background-- filereqclass/--background--
NAME
Class: filereqclass
Superclass: ROOTCLASS
Include File: <libraries/bgui.h>
FUNCTION
To provide a BOOPSI interface class to the ASL FileRequester. The
advantage of this class is that the objects remember their complete
settings like requester size, path, directory, file and pattern
strings as long as the object remains valid.
filereqclass/Methods filereqclass/Methods
NEW METHODS
FRM_DOREQUEST -- Sending this method to the object will open the
requester.
This method can return any of the following return codes:
FRQ_OK -- Ok. No problems.
FRQ_CANCEL -- The requester was cancelled by the user.
FRQ_ERROR_NO_MEM -- Out of memory.
FRQ_ERROR_NO_FREQ -- Could not allocate a FileRequester
structure.
CHANGED METHODS
OM_SET -- This method returns 0 when everything went OK. Uppon failure
it will return FRQ_ERROR_NO_MEM.
filereqclass/Attributes filereqclass/Attributes
NOTE
All the ASL filerequester attributes as defined in <libraries/asl.h>
are usable with this class. Applicability for these ASL attributes
is (ISGU).
NAME
FRQ_Drawer -- ( STRPTR )
FUNCTION
To obtain a pointer to the directory name of the filerequester.
Applicability is (G).
SEE ALSO
FRQ_File, FRQ_Pattern, FRQ_Path
NAME
FRQ_File -- ( STRPTR )
FUNCTION
To obtain a pointer to the file name of the filerequester.
Applicability is (G).
SEE ALSO
FRQ_Drawer, FRQ_Pattern, FRQ_Path
NAME
FRQ_Pattern -- ( STRPTR )
FUNCTION
To obtain a pointer to the pattern string of the filerequester.
Applicability is (G).
SEE ALSO
FRQ_Drawer, FRQ_File, FRQ_Path
NAME
FRQ_Path -- ( STRPTR )
FUNCTION
To obtain a pointer to the full path of the filerequester. This is
simply the directory with the file name AddPart()'d to it.
Applicability is (G)
SEE ALSO
FRQ_Drawer, FRQ_File, FRQ_Pattern, dos.library/AddPart()
NAME
FRQ_Left, FRQ_Top, FRQ_Width, FRQ_Height -- ( ULONG )
FUNCTION
To obtain the current position and size of the filerequester.
Applicability is (G).